Purpose: Use the Job Management screen to work with submitted jobs that have been processed, are currently processing, or are waiting to be processed. The jobs listed at this screen include each interactive session for the user.
This topic also discusses options you can use to review the jobs currently running and correct a job’s status if it is inconsistent.
In this topic:
• Job Management Screen Options
• Jobs Excluded from the Long Running Jobs Monitor
• Applying Changes to the Monitor Properties File
For more information: See:
• Display Active Batch Jobs (DABJ)
• Which Jobs are Active Batch Jobs?
• Verifying the Status of Active Batch Jobs
• If a Batch Job is not on the Display Active Batch Jobs Screen
• Display Active Batch Jobs Screen
How
to display this screen: Click the My
Jobs icon (
in the upper right area of a screen),
or select My Jobs from an Admin
screen (such as the About Application, Forms
Management Screen, Document
Management Screen, Commands, User Control, or System
Messages screens). When you advance to the screen this way, it displays
all jobs generated through your user ID. See the field descriptions and
screen options below for information on how to filter the jobs listed
on this screen.
Column sort: You can sort on any column by clicking the upward-facing and downward-facing arrows to the right of a column heading name. When you first click, the sort is in ascending alphanumeric (A-Z) or numeric (lowest to highest) order. Click again to change the sort to descending (Z-A) or numeric (highest to lowest) order.
Information on this screen:
Field |
Description |
In screen title: |
|
DB Environment |
The database associated with your CWSerenade session. |
|
|
At top of screen:
|
|
Provides the option for you to switch the job queue where one or more jobs should run. The system-delivered job queues are: • QBATCH (default) = The default job queue for most submitted jobs, such as reports and batch updates and processing. Processes one job at a time (single-threaded queue). • QSYSNOMAX = The default job queue for Generating Membership Orders (EGMO), jobs submitted through Working with Integration Layer Processes (IJCT), and all of the jobs submitted through Working with E-Commerce Job Control (EJCT) with the exception of the ECOMM_CANC job. Can process multiple jobs at the same time (multi-threaded queue). • QINTER = The job queue where interactive user sessions run. This job queue processes multiple jobs at the same time. • ASYNC = The job queue where background processes, submitted through Using the ASYNC Jobs (MBJC), run. Can process multiple jobs at the same time. • ECOMMERCE = The job queue where the ECOMM_CANC job (submitted through Working with E-Commerce Job Control (EJCT)) and the ORDER_EDIT job (generated through the ORDER_IN job in Working with Integration Layer Processes (IJCT)) run automatically. Can process multiple jobs at the same time. • PICKGEN = The default job queue for Streamlined Pick Slip Generation (WSPS), Reprocess Authorizations Screen (RPAA), and Processing Auto Deposits (SDEP). Processes one job at a time. |
|
<- Route Job |
Use this button to route a job to the queue selected in the Queue field, described above: • Select one or more jobs from the Job listings area, below • Select a queue from the Queue field • Click this button to move the job to the selected queue You can select a different route only if the job has not yet started to run (RDY status). |
Filter |
Click this button to refresh the information displayed on the screen based on job processing or filter options. See the Job Listings and screen options for information on how to filter based on the column headings. |
|
Default settings for jobs available for review: When you first advance to this screen, up to 25 jobs submitted by your user ID are currently available for review by scrolling up or down with the right-hand scroll bar. The jobs are listed in reverse chronological order (newest to oldest). Available jobs updated when you filter: When you enter or select any search criteria and then click Filter, the screen displays up to 25 jobs that match these criteria. Example: The screen currently includes 25 jobs available for review in reverse chronological order (newest to oldest): 20 of these jobs run in QBATCH, and 5 run in ASYNC. When you select QBATCH from the Queue field and click Filter, the screen displays up to 25 jobs that run in QBATCH. Adding jobs for review with the More option: Select More to add additional jobs to those available for review by scrolling with the right-hand scroll bar. This option is available only if additional jobs exist that meet the current filtering settings. Each time you click More, you add a maximum of 25 jobs to those available for review. Examples: • A user has submitted 37 jobs. When the user advances to this screen, 25 jobs are available for review and the More option is also available. When the user clicks More, the additional 12 jobs are added to those available for review, and the More option is removed. • A user has submitted 53 jobs. When the user advances to this screen, 25 jobs are available for review and the More option is also available. When the user clicks More, an additional 25 jobs are added to those available for review, and the More option is still available. When the user clicks More again, the remaining 3 jobs are added to those available for review, and the More option is removed. • A user has submitted 16 jobs. When the user advances to this screen, all 16 jobs are available for review, and the More option is not available. Filter criteria applied to additional jobs: If you currently have any filter criteria selected when you select More, the additional jobs displayed match your criteria. Example: If the jobs are currently filtered based on a user ID of DTHOMAS, selecting More adds up to 25 more jobs that were also generated by the user DTHOMAS. Available jobs restricted: If your user control record does not have All job authority selected, you cannot review jobs submitted by other users. Example: If you do not have All job authority, when you filter on a Job name of PICK_GEN, pick slip generation jobs submitted by other users are not displayed. |
|
User name |
The user name of the person who submitted the job, or who is using an interactive session. Defaults to your user ID. When you use the CWProcessIn message to start a periodic process, the forms are listed under your default user; see Using the CWProcessIn Message to Start a Periodic Process for background. Filter options: The following options are available for users whose All Job Authority setting is selected: • to display jobs submitted by another user: enter a complete, valid user ID and click Filter • to display jobs regardless of the user who submitted them: • clear the current entry in this field or enter ALL and click Filter, or • right-click anywhere in the Job Listings area and click Show All Jobs • to restrict the jobs displayed to your own user ID after displaying additional jobs: right-click anywhere in the Job Listings area and click Show My Jobs Note: Entering a different user ID and the Show All Jobs and Show My Jobs options are available only if the user control record is flagged for authority with the All Job Authority setting; otherwise, this field is display-only. For more information: See the User Configuration guide, available from your MICROS representative, for more information on setting up users. |
A code identifying the job. The job name for an interactive session has a name starting with QPADEV (for example, QPADEV0B9A). Defaults to blank. Note: The
reports icon ( Filter options: • to display jobs based on job name: enter a full or partial job name and click Filter • to display jobs regardless of name: if you have previously entered a job name, clear the entry and click Filter No report?
If there was no information matching the selection criteria for the report,
the system may not generate a blank report; instead, you see the reports
icon ( |
|
Job |
A system-assigned identification number to track the job. Defaults to blank. Filter options: • to display a particular job by number: enter a valid job number and click Filter • to display jobs regardless of number: if you have previously entered a job number, clear the entry and click Filter |
Status |
The current status of the job. Defaults to ALL. Possible statuses are: • ALL (default) = Select this option to display all jobs regardless of status. • RDY (Ready) = The job is currently waiting in the indicated job queue for processing because another job is currently active in that job queue, and the queue is single-threaded (processes only one job at a time). Optionally, you can expedite processing by routing the job to a different job queue that does not currently have a job running, or that is multi-threaded: Select the job, select the Queue at the top of the screen, and click <- Route Job. • HLD (Held) = The job is held. Optionally, you can release the job by: • Selecting the checkbox to the left of the job • Right-clicking anywhere in the Job listings area • Selecting Release • RUN = The job is currently running normally. It is not possible to hold the job or change its job queue. • FIN (Finished)
= The job has finished running normally. If there is a reports icon ( Note: Generated forms (such as pick slips, purchase orders, or checks) are available at the Forms Management (My Forms) screen, not the Document Management (My Docs) screen. |
|
• MSG (Message Wait) = Possible explanations: • CWSerenade has written a message to a log file, and the job cannot continue processing. • Someone restarted the SERENADE service or rebooted the application server while the job was active. In this situation, you should end the job at the Job Management screen and then start it again the usual way. • Occasionally, the async jobs go into MSG status even though they are continuing to process records. See Troubleshooting the Async Jobs for more information. • END = Someone has manually ended a job whose status was RUN, but was not running normally (perhaps because the server rebooted while the job was running). Use the Display Active Batch Jobs Screen to determine if the job is still running; and if it is, reset its status to RUN; see Verifying the Status of Active Batch Jobs. • ERR (Error) = Someone has manually ended a job that was not running normally. Integration layer jobs Jobs you start through the Working with Integration Layer Processes (IJCT) option might not display the current, correct status if they receive inbound messages and have not yet received any messages to process. |
|
Async jobs When the async jobs in the Background Job Control (MBJC) menu option are active, the system periodically checks the status of each async job, and changes the status to RUN, if necessary. For example, if the ORDR_ASYNC job is active and you end it at this screen, the system automatically changes the status of the job back to RUN. To start or stop the async jobs, use the Background Job Control (MBJC) menu option. See Working with the CNTL_ASYNC Job. Filter options: • to display jobs by status: select a status from the drop-down list and click Filter • to display jobs regardless of status: if you have previously selected a status, select ALL from the drop-down list and click Filter |
Started |
The date and time when the job started. Defaults to blank. NONE indicates the job has not yet started (the status is RDY). Filter options: • to display jobs started
on or after a specific date: click the calendar icon ( • to display jobs started on the current date: click the calendar icon, select Today from the bottom of the calendar, and click Filter • to display jobs regardless of start date: if you have previously selected a date, click the calendar icon, select Clear from the bottom of the calendar, and click Filter |
Ended |
The date and time when the job finished. Defaults to blank. NONE indicates the job has not yet finished (the status is RDY or RUN). Filter options: • to display jobs ended
on or before a specific date: click the calendar icon ( • to display jobs ended on the current date: click the calendar icon, select Today from the bottom of the calendar, and click Filter • to display jobs regardless of end date: if you have previously selected a date, click the calendar icon, select Clear from the bottom of the calendar, and click Filter |
Run Time |
The amount of time, in seconds, that the job took to run. Set to 0 if the job has not yet completed. Display-only. |
Queue |
The job queue where the job will run, is running, or ran. Defaults to ALL. See the Queue field above for a listing of system-delivered queues. Filter options: • to display jobs by queue: select a queue from the drop-down list and click Filter • to display jobs regardless of queue: if you have previously selected a queue, select ALL from the drop-down list and click Filter |
Log |
A link to a brief log file for the job; available if the job has finished running. This log provides just a list of the programs called in order to complete the job. See Logs for additional logs you can use for troubleshooting. |
) indicates that
the job has generated one or more reports. Once the job status is 
) next to the job, you can click
the icon to advance to the 
), select a date, and then
click Option |
Procedure |
Change which jobs are displayed on the screen |
|
Restrict or expand the list of displayed jobs based on one of the available column headings |
See the Job Listings for information on how to filter the jobs displayed based on various criteria. |
Display additional jobs that match the criteria currently in place |
By default, the screen lists a maximum of 25 jobs at a time. Select More to add additional jobs to those available for review. This option is available only if there are additional jobs that could be available. See the Job Listings for more information and examples. Note: When you select More: • Any current filter criteria (such as user ID, queue, or status) are retained, and up to 25 additional jobs that match your criteria are displayed. For example, if the jobs were currently filtered based on a status of FIN, when you select More, the screen adds up to 25 additional jobs in FIN status to those available for review. • If the selection checkboxes to the left of any jobs are currently selected, the checkboxes are cleared. |
Refresh data listed on the screen |
Click Filter. Newly submitted jobs are added to the screen in RDY status as they are submitted, and the status of existing jobs is updated. |
Sort by column |
Click the upward-facing and downward-facing arrows to the right of a column heading name. When you first click, the sort is in ascending alphanumeric (A-Z) or numeric (lowest to highest) order. Click again to change the sort to descending (Z-A) or numeric (highest to lowest) order. |
Change a job’s status or queue |
|
Hold a job |
If the job has not yet processed (its status is RDY), you can hold it by: • Selecting the checkbox to the left of the job • Right-clicking anywhere in the Job listings area and selecting Hold. |
Release a job |
If the job is currently held (its status is HLD), you can hold it by: • Selecting the checkbox to the left of the job • Right-clicking anywhere in the Job listings area and selecting Release. |
Hold or release all displayed jobs |
• Right-click anywhere in the Job listings area and selecting Select All • Right-clicking anywhere in the Job listings area and selecting Hold or Release Note: Only jobs that are currently eligible for display are selected when you use the Select All option, so only those available for display are held or released when you use Select All. By default, a maximum of 25 jobs are available for display when you first advance to the screen, but by selecting the More option you can display additional jobs in groups of up to 25. See the Job Listings for a discussion and examples. |
Route one or more jobs to a different queue |
If the job is currently ready for processing (its status is RDY) you can route it to a different queue by: • Selecting the checkbox to the left of the job • Selecting a different queue from the Queue drop-down list at the top of the screen • Selecting <- Route Job at the top of the screen Why route? You might want to route a job to a different queue to expedite processing (for example, if another job is currently running in the job’s default queue, and the queue is single-threaded, meaning that only one job at a time can run in that queue at a time). |
End a job that is currently running |
• Select the checkbox to the left of a submitted job • Right-click anywhere in the Job listings area and click End A window opens if you have selected to end an active job: Warning! You have chosen to end one or more active jobs. PRESS OK TO END JOB, or PRESS CANCEL TO LEAVE JOB RUNNING. At this window, select OK to end the job and update its status to END. You might wish to end a job that is currently running if you suspect that the job is not running normally (perhaps because the server rebooted while the job was running). Note: Sometimes when you select to end a job, the job does not end and remains running. You can use the Display Active Batch Jobs Screen to determine if the job you have ended is still running. If the job is still running and you want to end it, end the process that submitted the job. For example, if the job is associated with an integration layer process, you will need to use the Working with Integration Layer Processes (IJCT) menu option to end the integration layer process. Once you end the process associated with the job, the system ends the job and removes the job from the Display Active Batch Jobs Screen since it is no longer running. |
End all displayed jobs |
• Right-click anywhere in the Job listings area and click Select All • Right-click anywhere in the Job listings area and click End. A window opens if you have selected to end any active job: Warning! You have chosen to end one or more active jobs. PRESS OK TO END JOB, or PRESS CANCEL TO LEAVE JOB RUNNING. At this window, select OK to end the job and update its status to END. Note: Only jobs that are currently available for display are selected when you use the Select All option, and only those jobs end when you use this option. By default, a maximum of 25 jobs are available for display when you first advance to the screen, but by selecting the More option you can display additional jobs in groups of up to 25. See the Job Listings for a discussion and examples. |
Delete one or more jobs |
|
Delete an individual job |
• Select the checkbox to the left of a submitted job • Right-click anywhere in the Job listings area, then click Remove Note: Deleting a job also automatically deletes all generated reports for that job that would also be available under the Document Management (My Docs) screen; however, it does not delete forms that are available at the Forms Management (My Forms) screen. |
Delete all displayed jobs |
• Right-click anywhere in the Job listings area, then select Select all • Right-click again anywhere in the Job listings area, then click Remove to delete all displayed jobs Note: • Jobs that are currently running, including interactive jobs, are not deleted when you use the steps above. • Click Unselect all if you clicked Check all inadvertently or do not want to delete all displayed jobs. • Deleting a job also automatically deletes all generated reports for that job that would also be available under the Document Management (My Docs) screen; however, it does not delete forms that are available at the Forms Management (My Forms) screen. • Only jobs that are currently available for display are selected when you use the Select All option, so only those jobs are deleted. By default, a maximum of 25 jobs are available for display when you first advance to the screen, but by selecting the More option you can display additional jobs in groups of up to 25. See the Job Listings for a discussion and examples. |
Display additional information about a job or advance to a different screen Note: If you advance to a different screen and then return, your filter entries are not retained. For example, if you are currently filtering on a specific queue, and you advance to the Document Management (My Docs) screen and return, the Queue column no longer filters on that queue. |
|
Review the log for a job |
Click Log file for a job to display its log. |
Display the server where a user is logged in, or display the command used to execute a job |
Move your cursor over the checkbox to the left of the job entry. The Command field displays: • User interactive sessions: the name and IP address of the server where the user is logged in. For example, a Command of cwserenade-srv/123.45.100.1 indicates that the user is logged into the CWSerenade on the cwserenade-srv server, which has an IP address of 123.45.100.1. • Batch or submitted jobs: the command executed for the job, such as CALL PGM(flr2012 ) PARM(' ' x'003F' x'00055F' 'N'). |
Review, and optionally print, reports generated by a job |
Click the reports
icon ( Note: Forms, such as pick slips, purchase orders, or checks, are available from the Forms Management Screen rather than the Document Management Screen. |
Display information about CWSerenade |
Select About. |
Advance to the Forms Management Screen |
Select My Forms. |
Advance to the Document Management Screen |
Select My Docs. |
Advance to the Advanced Commands screen. From this screen, you can advance to working with user control records if you have sufficient authority. |
Select Advanced commands. |
Return to the previous CWSerenade screen |
Select Exit. |
Question |
Possible Answer(s) |
Why are the background async jobs not starting correctly? |
|
Why can’t I change the status of an async job? |
When the async jobs in the Background Job Control (MBJC) menu option are active, the system periodically checks the status of each async job, and changes the status to RUN, if necessary. For example, if the ORDR_ASYNC job is active and you end it at this screen, the system automatically changes the status of the job back to RUN. To start or stop the async jobs, use the Background Job Control (MBJC) menu option. See Working with the CNTL_ASYNC Job. |
Why do I receive the error Function key not allowed when I press F5 to refresh the Job Management screen? |
To refresh the Job Management screen, click Filter. |
Why does a submitted job go into MSG status? |
Typically, this occurs because someone has stopped and restarted the SERENADE service. If this is not the reason, check the following logs to determine other possible reasons, looking for messages that were written to the log at the time when the job went into MSG status. For example, an error such as out of memory, program not found, or null pointer might help you determine the cause of the problem. The jobs and the activities they track are: • CWDirect Log: General application processing. • CWSerenade MQ Message Log: XML and transactional message processing and message contents. • CWSerenade Application Log: CWSerenade application processing. • CWSerenade Response Log: Jobs that require user intervention in order to proceed, such as authorizations and deposits, and stored value card activations, balance inquiries and authorization reversals. • CWSerenade Trace Log: Internal activity related to CWSerenade application processing. • CWSerenade Manifest Log: Manifest processing. To Reset the Job Status Use the Display Active Batch Jobs Screen to determine if the job is actively running. • If the job is listed on the Display Active Jobs screen, the job is running, but the status of the job on the Job Management Screen is not accurate. To correct, right-click on the job at the DIsplay Active Jobs screen and select Change to RUN to update the status of the job on the Job Management screen to RUN. • If the job is not on the Display Active Jobs screen, the job is not running. To correct, at the Job Management screen: • Select the checkbox to the left of the job • Right-click anywhere in the Job listings area and select End • Again, select the checkbox to the left of the job • Right-click anywhere in the Job listings area and select Remove You will need to resubmit the job in order to run it again. |
Are job entries automatically deleted? |
Jobs older than the JOB_RETENTION_DAYS property in the CWDirectCP Properties File are deleted when you restart CWSerenade. |
After I deleted all of the documents for a submitted job, why does the job remain on the My Jobs screen? |
Deleting all of the output for a submitted job does not delete the submitted job. You need to use the Remove option to remove the job. Note: You should remove a submitted job if it is in finished (FIN) status. Evaluate the status of a job that is in an error (ERR) or message (MSG) status before removing it. |
Does deleting a job entry delete its associated documents? |
Deleting a job entry automatically deletes all generated reports for that job that would also be available under the Document Management (My Docs) screen; however, it does not delete forms that are available at the Forms Management (My Forms) screen. |
How can I review all of the jobs for a particular job queue? |
On the Job Management screen, clear the User Name field, select the job queue from the Queue drop down box and click Filter. Note: This option is available only if you have the required authority based on your user control record. Contact your MICROS representative if you need information on configuring user control records. |
Why can’t I see jobs submitted by all users? |
If your user control record does not have All job authority selected, you cannot review jobs submitted by other users. Contact your MICROS representative if you need information on configuring user control records. |
Can I choose the job queue the system uses to process a job? |
When a job is first submitted to the job queue, the system automatically chooses which job queue to use to process the job, based on the type of job submitted. However, if the job has not yet processed (its status is RDY), you can route it to a different job queue by: • Selecting the checkbox to the left of the job • Selecting the job queue from the drop-down box next to the <- Queue button • Selecting Route to Queue. This option is useful if, for example, a large job is currently active in QBATCH, and you would like to run a report job in a separate job queue so it will process quickly. |
How can I review and query batch jobs that have run? |
The Display Job History (DJHY) screen displays the Job History table. You can review the data and search by server, date range, job queue, and/or job name. The Job History table in the CWSerenade database lists batch jobs that have run, including batch jobs that have been removed from the Job Management Screen. These records remain in this table up to the specified purge days. The fields in this table are: • Job #: The system-assigned identification number to track the job. • Job Name: The name of the job, such as PICK_OUT or BILL_ASYNC. • Start Date: The date the job was started. • Start Time: The time the job was started. • End Date: The date the job finished. Set to 0 if the job did not end. • End Time: The time the job finished. Set to 0 if the job did not end. • Submitted By: The user ID of the person who submitted the job. • Job Queue: The job queue where the job ran, such as QSYSNOMAX or ASYNC. • Server: The name and IP address of the CWSerenade application server where the job ran. Purging Records in the Job History Table The JOB_HISTORY_PURGE_DAYS setting in the cwdirectcp_managed.properties file defines how long to retain a batch job in the Job History table before the system purges it automatically based on the job’s End date. The default setting is 30 days. The system submits the Job History purge process each time you start the application server. Job History records that do not have an End Date (indicating the job did not end) are not purged. |
How do I prevent the information on the screen from displaying incorrectly? |
CWSerenade 3.0 and higher has been tested to display correctly in Internet Explorer 8.0. Also, on release 3.0 or higher of CWSerenade, you need to have Compatibility View turned off to prevent display issues. See Configuring Internet Explorer 8.0® or Higher (Remove Compatibility View) for more information. |
Long Running Jobs Monitor watches the batch jobs running on the Job Management Screen and sends a Long Running Job Email to a specified email address if a job runs without ending longer than a specified time.
Starting the Long Running Jobs Monitor: The Long Running Jobs Monitor starts when you:
• stop and restart the SERENADE service (or the application server).
• make a change to the Monitor Properties File and select to reload the changes; see Applying Changes to the Monitor Properties File for instructions.
Application log: Each time the Long Running Jobs Monitor is started or reloaded, the system writes a message to the CWSerenade Application Log if its Logging Level is set to INFO, indicating:
the Long Running Job Monitor is active and monitoring running batch jobs. Note: The system also writes this message to the Application log when the time defined in the CWDIRECTCP_LR_JOB_MONITOR_ REPEAT_ALERT_AFTER_X_CYCLES setting in the Monitor Properties File is reached. |
Long running job monitor is actively monitoring. |
the email address(es) that receive the Long Running Job Email, as defined in the CWDIRECTCP_LR_JOB_MONITOR_ ALERT_TO_EMAIL_ADDRESS setting in the Monitor Properties File. |
Long running job monitor will send emails to : sward@commercialware.com |
the batch jobs that are not watched; see Jobs Excluded from the Long Running Jobs Monitor. |
Long running job monitor not monitoring : ORDR_ASYNC Long running job monitor not monitoring : CUST_OUT Long running job monitor not monitoring : EMAIL_OUT |
the batch jobs that the Long Running Jobs Monitor watches using a time other than the default time, as defined in the CWDIRECTCP_LR_JOB_MONITOR_ ALERT_AFTER_X_MINUTES_ OVERRIDE setting in the Monitor Properties File. |
Long running job monitor will alert on job : PICK_GEN after it runs over 120 minutes. |
In addition, the system writes a message to the Application log if you do not set up the Monitor Properties File correctly; for example: CWDIRECTCP_LR_JOB_MONITOR_REPEAT_ALERT_AFTER_X_CYCLES is not numeric. If an error occurs, you need to correct the error and stop and restart the SERENADE service (or the application server).
Jobs Excluded from the Long Running Jobs Monitor
The Long Running Jobs Monitor watches batch jobs in a RUN status only.
The Long Running Jobs Monitor does not watch:
• interactive jobs.
• batch jobs that are not running (for example, the job is in a ready status or is on hold).
• any integration layer job:
• that does not have queues defined.
• that has a process queue marked as Enabled on the Integration Layer Process Queue Screen. The system excludes any active batch job whose name matches the Inbound job name defined for the integration layer process queue. If an Inbound job name is not defined, the system excludes any active batch job whose name matches the Process ID defined for the integration layer process queue. Note: If you change the Enabled flag for an integration layer process queue job, your changes take effect the next time you select Change in Refresh System Properties (PROP) if the CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER setting in the Monitor Properties File is set to RELOAD or when you stop and restart the SERENADE service (or the application server).
• batch jobs included in the CWDIRECTCP_LR_JOB_MONITOR_EXCLUDE_JOBS list in the Monitor Properties File.
The system generates this email when a batch job runs longer than a specified time.
• If a batch job is not defined in the CWDIRECTCP_LR_JOB_MONITOR_EXCLUDE_JOBS or CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_OVERRIDE settings in the Monitor Properties File, the system generates this email when the batch job runs longer than the number of minutes defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_DEFAULT setting.
• If a batch job is defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_OVERRIDE setting in the Monitor Properties File, the system generates this email when the batch job runs longer than the number of minutes defined after the batch job name. For example, if this setting contains PICK_GEN,120, the system sends a Long Running Job Email if the PICK_GEN batch job runs longer than 120 minutes.
The CWDIRECTCP_LR_JOB_MONITOR_ALERT_TO_EMAIL_ADDRESS setting in the Monitor Properties File defines the email address(es) that receive this email.
Sample email: If more than one batch job requires a Long Running Job email at the same time, the system sends one email for both jobs.
From: |
cwserenade@MICROS.com |
To: |
Bernadette Miranda |
Subject: |
Long Running Job |
PICK_GEN submitted by SWARD has been running for over 120 minutes. |
|
What to do if you receive this email: If you receive a Long Running Job email, evaluate the batch job and determine if the length of time it has been running is within a normal run time.
• If the batch job is within a normal run time, let the job run until it is finished.
• If you think the batch job has been running for too long and you wish to end it, have all users log out of CWSerenade and restart the application server where the batch job is running. Note: Restarting the application server will end all batch jobs running on this server.
Sending another Long Running Job Email for the Same Job
If a batch job is still running after the Long Running Jobs Monitor has watched the job for the number of times defined in the CWDIRECTCP_LR_JOB_MONITOR_REPEAT_ALERT_AFTER_X_CYCLES setting in the Monitor Properties File, the system sends another Long Running Job email.
Example: The Monitor Properties File has the following settings:
• LR_JOB_MONITOR_RUNS_EVERY_X_MINUTES = 30
• CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_DEFAULT = 60
• LR_JOB_MONITOR_REPEAT_ALERT_AFTER_X_CYCLES = 2
• CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_OVERRIDE = PICKGEN,90
1. You submit the PICK_GEN job.
2. After 30 minutes, the Long Running Jobs Monitor looks for jobs that have been running longer than the number of minutes defined in the ALERT_AFTER_X_MINUTES_DEFAULT or ALERT_AFTER_X_MINUTES_OVERRIDE setting. Because the PICK_GEN job is included in the ALERT_AFTER_X_MINUTES_OVERRIDE setting (PICK_GEN,90) and the number of minutes the job has been running is 30, the system does not send a Long Running Job Email.
3. After another 30 minutes (60 minutes total), the Long Running Jobs Monitor looks for jobs that have been running longer than the number of minutes defined in the ALERT_AFTER_X_MINUTES_DEFAULT or ALERT_AFTER_X_MINUTES_OVERRIDE setting. Because the PICK_GEN job is included in the ALERT_AFTER_X_MINUTES_OVERRIDE setting (PICK_GEN,90) and the number of minutes the job has been running is 60, the system does not send a Long Running Job Email.
4. After another 30 minutes (90 minutes total), the Long Running Jobs Monitor looks for jobs that have been running longer than the number of minutes defined in the ALERT_AFTER_X_MINUTES_DEFAULT or ALERT_AFTER_X_MINUTES_OVERRIDE setting. Because the PICK_GEN job is included in the ALERT_AFTER_X_MINUTES_OVERRIDE setting (PICK_GEN,90) and the number of minutes the job has been running is 90, the system sends a Long Running Job Email.
5. After another 30 minutes (120 minutes total), the Long Running Jobs Monitor looks for jobs that have been running longer than the number of minutes defined in the ALERT_AFTER_X_MINUTES_DEFAULT or ALERT_AFTER_X_MINUTES_OVERRIDE setting. Since a Long Running Job Email has already been generated for the PICK_GEN job, the system looks at the RUNS_EVERY_X_MINUTES and REPEAT_ALERT_AFTER_X_CYCLES settings to determine when to send another email (run every 30 minutes x 2 cycles = send another email after an additional 60 minutes). Because the PICK_GEN job has been running for an additional 30 minutes over the override, the system does not send an email.
6. After another 30 minutes (150 minutes total), the Long Running Jobs Monitor looks for jobs that have been running longer than the number of minutes defined in the ALERT_AFTER_X_MINUTES_DEFAULT or ALERT_AFTER_X_MINUTES_OVERRIDE setting. Since a Long Running Job Email has already been generated for the PICK_GEN job, the system looks at the RUNS_EVERY_X_MINUTES and REPEAT_ALERT_AFTER_X_CYCLES settings to determine when to send another email (run every 30 minutes x 2 cycles = send another email after an additional 60 minutes). Because the PICK_GEN job has been running for an additional 60 minutes over the ALERT_AFTER_X_MINUTES_OVERRIDE setting, the system sends another Long Running Job email.
The Monitor Properties file contains the settings required to enable the Long Running Jobs monitor.
Where is the file located? This file is located in the same folder as the other CWSerenade properties files: C:\Serenade\server\conf\cwdirectcpproperties\cwdirectcp_monitor.properties, where C: represents the root of the default drive.
How to edit the file: MICROS recommends that you first make a backup copy of the configuration file. Then use a text editor such as Notepad or Wordpad, being careful not to change any of the settings except those indicated below.
Your changes take effect the next time you select Change in Refresh System Properties (PROP) if the CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER setting in the Monitor Properties File is set to RELOAD or when you stop and restart the Serenade service (or the application server).
Property Name |
Description |
CWDIRECTCP_LR_RUN_JOB_MONITOR_ON_THIS_SERVER |
Indicates whether the Long Running Jobs Monitor runs on this application server. Valid values: Y = The Long Running Jobs Monitor runs on this server. N (default) or blank = The Long Running Jobs Monitor does not run on this server. Note: If you are using a multiple application server environment, set this value to Y on one server only. Typically, you would set this to Y on the application server that runs batch jobs. |
CWDIRECTCP_LR_JOB_MONITOR_RUNS_EVERY_X_MINUTES |
Required; must be numeric. How often, in minutes, the Long Running Jobs Monitor wakes up and looks at the running batch jobs on the Job Management Screen to determine if a job has been running longer than the number of minutes defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_DEFAULT setting. The default setting is 15 minutes. |
Required; must be numeric. Indicates how long, in minutes, a job must be running before the system sends a Long Running Job Email to the email address defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_TO_ EMAIL_ADDRESS. Note: The system applies this time to all batch jobs not included in the CWDIRECTCP_LR_JOB_MONITOR_EXCLUDE_JOBS list or the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_OVERRIDE list. The default setting is 30 minutes. |
|
Required; must be numeric. Indicates how many times the Long Running Jobs Monitor must find the same running batch job before sending another Long Running Job Email. Example: The Long Running Jobs Monitor configuration is as follows: LR_JOB_MONITOR_RUNS_EVERY_X_MINUTES = 15 LR_JOB_MONITOR_REPEAT_ALERT_AFTER_X_CYCLES = 5 If the PICK_GEN job runs longer than 15 minutes, the system sends a Long Running Job email. The system will not send another Long Running Job email unless the PICK_GEN job is still running after an additional 75 minutes (15 minutes x 5 cycles = 75). |
|
CWDIRECTCP_LR_JOB_MONITOR_ALERT_FROM_EMAIL_ADDRESS |
Required. The “from” email address for the Long Running Job Email. |
Required. The list of email addresses that receive the Long Running Job Email when a job requires user evaluation. Each email address entered must be separated by a semi-colon (;). For example: email1@add.com;email2@add.com. |
|
Optional. A list of batch jobs excluded from the Long Running Jobs Monitor evaluation. Typically, these are jobs that run all day, such as the Async, ECommerce, and Drop Ship Integration jobs, or jobs that do not require a Long Running Job Email if they run too long. Separate each job in the list with a comma. For example: IX_CDC,CNTL_ASYNC,ORDR_ASYNC,OTHR_ASYNC,BILL_ASYNC. The default setting is IX_CDC,CNTL_ASYNC,ORDR_ASYNC,OTHR_ASYNC,BILL_ASYNC,EBO_ASYNC,EC_STS_INQ,EC_RETURNS,EC_CANCELS,EC_CLEANUP,EC_CAT_REQ. Note: If you enter a batch job name here and the job is also defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_OVERRIDE setting, the system considers the job an override and it is not excluded from the Long Running Jobs monitor. |
|
Optional. A list of batch jobs that the Long Running Jobs Monitor watches using a time other than the default time defined in the CWDIRECTCP_LR_JOB_MONITOR_ALERT_AFTER_X_MINUTES_DEFAULT setting. The format for this setting is BATCH_JOB_NAME,99, where BATCH_JOB_NAME is the name of the batch job, and 99 is how long, in minutes, the job must run before the system sends a Long Running Job Email. Separate each batch job name and its time with a comma; for example: BATCH_JOB_NAME1,120,BATCH_JOB_NAME2,30. Example: The default time is 60 minutes, indicating a job must be running for 60 minutes before the system sends a Long Running Job email. However, the PICK_GEN job runs longer than 60 minutes on a regular basis and you don’t want to be notified about this job unless it runs longer than 120 minutes. In this situation, enter PICK_GEN,120. The default setting is blank. |
|
Optional. Allows changes to the Monitor Properties file without having to stop and restart the SERENADE service (or the application server). See Applying Changes to the Monitor Properties File for instructions. RELOAD = The next time the Long Running Jobs Monitor wakes up, reload the settings in the Monitor Properties file and restart the Long Running Jobs Monitor to use the new settings. EXIT = Stop the Long Running Jobs Monitor and do not send alerts until the SERENADE service (or the application server) is stopped and restarted. When you stop and restart the SERENADE service (or the application server), the new settings will take effect. RUN or any other value, including blank = Run the Long Running Jobs monitor using the current settings. Important: If you make a change to the properties file and change this setting to RELOAD or EXIT, after your change takes effect, make sure you change this setting back to RUN, blank, or any other value other than RELOAD or EXIT. The default setting is blank. |
For more information: See:
• Resetting Processes and Jobs on Server Startup for more information on the settings in the Monitor Properties file related to resetting processes and jobs on server startup.
• Running a Periodic Process on Server Startup for more information on the settings in the Monitor Properties file related to running a specified periodic process and its assigned periodic functions on server startup.
Applying Changes to the Monitor Properties File
Use the following steps to apply changes to the Monitor Properties file.
1. |
Use a text editor such as Notepad or Wordpad, to update the settings in the Monitor Properties file you wish to change. |
2. |
Before exiting the Monitor Properties file, use the CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER setting to indicate when you want the changes to take effect. • RELOAD = The next time the Long Running Jobs Monitor wakes up, reload the settings in the Monitor Properties file and restart the Long Running Jobs Monitor to use the new settings. • EXIT = Stop the Long Running Jobs Monitor and do not send any Long Running Job emails until the SERENADE service (or the application server) is stopped and restarted. When you stop and restart the SERENADE service (or the application server), the new settings will take effect. |
3. |
Save and exit the file. |
4. |
Select Change in Refresh System Properties (PROP) to have the changes in the Monitor Properties file take effect. |
5. |
the next time the Long Running Job Monitor wakes up, it looks at the CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER setting. • If the CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER setting is RELOAD, the job restarts and uses the new settings. The system writes a message to the Application log indicating the job has restarted: Long running job monitor is actively monitoring. • If the CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER setting is EXIT, the job shuts down. |
6. |
Once the Long Running Jobs Monitor has restarted based on the CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER setting, change this setting to RUN, blank, or any value other than RELOAD or EXIT and save and exit the file. |
7. |
Select Change in Refresh System Properties (PROP) to have the change to the CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER setting take effect. |
Important: After the changes take effect, make sure you change the CWDIRECTCP_LR_JOB_MONITOR_CONTROLLER setting back to RUN, blank, or any other value other than RELOAD or EXIT. |
|
